Repository navigation
docs: declare the Staking tag in the OpenAPI spec - #2699
Merged
rafa-stacks merged 1 commit intoOct 2, 2026
Merged
Conversation
rafa-stacks
reviewed
Oct 2, 2026
rafa-stacks
reviewed
Oct 2, 2026
werner-stacks
force-pushed
the
docs/declare-staking-tag
branch
from
October 2, 2026 15:39
1492e04 to
a91db25
Compare
rafa-stacks
approved these changes
Oct 2, 2026
rafa-stacks
left a comment
rafa-stacks
left a comment
Collaborator
There was a problem hiding this comment.
Thanks @werner-stacks !
Contributor
Author
|
I don't have permission to merge would you mind? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The 15 v3 Bitcoin Staking endpoints use
tags: ['Staking'], butStakingis not declared in the top-leveltagsarray of the OpenAPI spec. Tools that build navigation from that array generate no page or description for these endpoints. docs.stacks.co, which renders this spec through GitBook, currently works around it with a hand-written page (stacks-network/docs#1891).This PR declares
Stakinginsrc/api/schemas/openapi.tswith a description and regeneratesopenapi.yaml.The second commit adds
x-page-title: Proof of Transferto the existing tag. GitBook title-cases tag names, so the page currently renders as "Proof Of Transfer". Other OpenAPI tools ignorex-extensions. Happy to drop that commit if you would rather keep vendor extensions out of the spec.Type of Change
Checklist